tts_voice object

This method will speak a given string, interrupting all other queued strings, and will pause execution until the string is spoken.

bool speak_interrupt_wait(string text)

Parameters:
text
The text to speak.

Return value:
true on success, false on failure.

Remarks:
All previous text queued by the speak or speak_interrupt method will be cleared, and the new text spoken straight away.

Because script execution is paused while the text inside the speak_interrupt_wait method is being spoken, it cannot be stopped or interrupted.

Example:
// Add various text to a buffer and interrupt it.

tts_voice speech;

void main()
{
speech.speak("This is text1.");
speech.speak("This is text2.");
speech.speak("This is text3.");
wait(300);
speech.speak_interrupt_wait("This is text4 interrupting all previous announcements.");
}